home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 015 / okipie.arc / OKIPIE.DOC next >
Encoding:
Text File  |  1987-10-22  |  6.4 KB  |  184 lines
  1. OKIPIE DOCUMENTATION
  2. -----------------------------------------------------------------------
  3. If you find this program of value, relax.  I don't want your money.
  4. However, if you are in an extremely generous mood, and have a spare 80386
  5. machine lying around, here's my address:
  6.  
  7.     James Bumgardner
  8.     4741 Clybourn Ave #1    
  9.     North Hollywood, CA 91602
  10.     818-766-0594 (PLINK BUM)
  11.  
  12. I'll also accept postcards and trinkets.
  13. -----------------------------------------------------------------------
  14.  
  15. Contents of this library:
  16.  
  17.     OKIPIE.EXE        Pie Graph Maker
  18.     OKIPIE.DOC        This File
  19.     PSAMPLE.DAT        A Sample Pie Graph Source File
  20.     PIEDEMO.BAT        A Demonstration
  21.     OKIPIE.TXT        Pie Graph Header File
  22.  
  23. OKIPIE produces hi-resolution (300 dpi) pie and line graphs.  It works
  24. with the program LAZER.EXE which can be found in LAZER.ARC.
  25.  
  26. The pie graphs are circular (1024 X 1024), with an optional 3-D shadow
  27. effect and exploded slices.  You can have up to 2 centered titles,
  28. and data-titles all around the graph.  Unlike LOTUS, the data-titles
  29. are properly centered outside of each slice.
  30.  
  31. OKIPIE translates an easy to read SOURCE file into two new files, a
  32. bitmap of graphics data, and a new text file which contains the text
  33. and typesetting instructions.
  34.  
  35. All the text and numbers on the graphs use regular laser printer
  36. fonts, rather than raster graphics.  This speeds up graph generation,
  37. and allows you to use your own font library.  This program works with
  38. either OKIDATA LASERLINE resident fonts, or with download fonts.  If
  39. you've got an 18 pt and 10 pt resident font, you can modify it to work
  40. with those as well by changing OKIPIE.TXT. 
  41.  
  42. LAZER
  43. -----
  44. The program LAZER (not included here, but available on this BBS) is an
  45. interpreter which reads the typesetting files.  It translates the
  46. typesetting commands into HP LaserJet+ commands, as well as
  47. downloading fonts and bitmaps to the printer. 
  48.  
  49. The advantages of using LAZER, as opposed to having OKIPIE send its
  50. commands directly to the printer, are twofold.  First, if there is a
  51. problem with the output, such as a spelling error, you can correct the
  52. text without having to generate the bitmap over again.  In the same vein,
  53. you can also make minor cosmetic changes pretty easily.  Secondly, this
  54. method makes the printer driver more independent, permitting the
  55. creation of Typesetting programs for other printers. 
  56.  
  57. LAZER.EXE is a pretty useful program in it's own right, apart from
  58. being used to print graphs.  I use it to design business forms and as
  59. a poor man's page-setter.  However if you just want to print graphs,
  60. you don't need to know anything about it.  If you're curious, the
  61. documentation for LAZER is in the file LAZER.DOC. 
  62.  
  63. USAGE
  64. -----
  65.   OKIPIE uses this syntax:
  66.  
  67.     OKIPIE sourcefile [outfile] [-m mapfile]
  68.  
  69. For Example:
  70.  
  71.     OKIPIE cheese.dat
  72.     OKIPIE cheese.dat special.gra
  73.     OKIPIE cheese.dat -m cheese.map
  74.  
  75. While constructing the graph, OKIPIE wil print "Slice X" for each
  76. slice of the pie.  This is to let you know that your computer hasn't
  77. died.  It takes about a minute to draw a reasonably complex graph.
  78.  
  79. When finished drawing, OKIPIE will quickly output the bitmap and exit.
  80. Use LAZER to print the graph:
  81.  
  82.     LAZER cheese.gra        (Output to LPT1)
  83.     LAZER cheese.gra LPT2        (Output to LPT2)
  84.     LAZER cheese.gra outfile    (Output to a very large file)
  85.  
  86. LAZER will take up to 5 minutes to print the graph (usually 2 or 3),
  87. depending on how many fonts you're downloading, and the speed of your
  88. printer.
  89.  
  90. The outfile name is optional and defaults to *.GRA.  It's just
  91. a regular text file with the typesetting instructions for LAZER.
  92. Try TYPEing or LISTing the .GRA file to see what it looks like.
  93.  
  94. The bitmap name is optional and defaults to PIE.MAP.  The bitmaps are
  95. approx 132K and will eventually consume all your disk-space if you don't
  96. purge them from time to time, this is why OKIPIE normally erases the old
  97. map.  The mapfile is not in any standard format known to me, but is quite
  98. simple:
  99.     Height (2 bytes)
  100.     Width  (2 bytes)
  101.     Data [lots of bytes]
  102.  
  103.  
  104. PIE SOURCE FILES
  105. ----------------
  106. Here is a sample Pie Source File:
  107.  
  108. ; (comment) this is the start of the file
  109. ;
  110. FONT 0 \fonts\emerald
  111. TITLE    Distribution of Lucky Charms
  112. SUBTITLE September, 1987
  113. SHADOW
  114. ;
  115. 123 Yellow Moons
  116. 102 Green Clovers
  117. 75 Blue Diamonds
  118. 23 Pink Hearts
  119. ; end of file
  120.  
  121. Not much to it really.  All lines that start with a number are considered data.
  122. You may follow each number with text to be printed next to the slice.
  123.  
  124. All lines that start with a word are commands.  You may abbreviate all
  125. commands down to 2 letters.
  126.  
  127. COMMAND            MEANING
  128. -------            -------
  129.  
  130. TITLE string        This is the title of the graph.
  131.  
  132. STITLE string or
  133. SUBTITLE string        This is the sub-title of the graph.
  134.  
  135. EXPLODE [n,...]        This tells OKIPIE to explode one or more slices.
  136.             Slice numbers start with 0.
  137.  
  138. SHADOW [dots]        This makes OKIPIE use a 3-D Shadow effect.
  139.             You may use a number to indicate shadow thickness,
  140.             which defaults to 20 dots.  There is no hidden-line
  141.             algorithm, so shadows on the upper-left quadrant
  142.             may collide with other slices.  To avoid this, don't
  143.             explode slices in that quadrant.  Also, thick shadows
  144.             at the bottom of the circle will be clipped.
  145.  
  146. THICKNESS n        This sets the pen width, which defaults to 4 dots
  147.             on either side of the line.
  148.  
  149. SORT            This sorts the slices from largest to smallest,
  150.             typical Pie Chart format.  The Explode Command
  151.             refers to post-sorted slices.
  152.  
  153. INSIDE            Center the text INSIDE the slices.  This is only
  154.             effective with big slices and small text.
  155.  
  156. PERCENTS        Includes percentages with the text of each slice.
  157.             Example: Blue Moons (15%)
  158.  
  159. NUMBERS            Includes numbers with the text of each slice.
  160.             Example: Blue Moons (560)
  161.  
  162. Both PERCENTS and NUMBERS:     Blue Moons (560 - 15%)
  163.  
  164.  
  165. FONT # fontname        This causes OKIDATA to use a width table from
  166.             a download font, allowing it to properly center the
  167.             letters.  The Typesetting File will contain a command
  168.             to download this font.
  169.  
  170.             FONT 0 is for the title.
  171.             FONT 1 is for the subtitle
  172.             FONT 2 is for the slice text.
  173.  
  174.             If you omit these commands, OKIPIE will use the
  175.             resident fonts on the Okidata Laserline Printer.
  176.             I made crude guesses as to these font widths, but
  177.             they seem to center OK.
  178.  
  179.             FONT 0 Defaults to Helvetica Bold 18
  180.             FONT 1 Defaults to Times Roman 10
  181.             FONT 2 Defaults to Times Roman 10 Italic
  182.  
  183. ** End of Documentation **
  184.